//Portions Copyright (C) 2011 Randall Shattuck
//Portions Copyright (C) 2007-2010 Owners of libeveapi 
//    (http://libeveapi.googlecode.com)
//
//EveDashboard.Api was forked from libeveapi 1.1.3
//
//This program is free software; you can redistribute it and/or modify it under
//the terms of the GNU General Public License as published by the Free Software 
//Foundation; either version 2 of the License, or (at your option) any later 
//version.
//
//This program is distributed in the hope that it will be useful, but WITHOUT 
//ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
//FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 
//details. You should have received a copy of the GNU General Public License 
//along with this program; if not, write to the Free Software Foundation, Inc.,
//59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//-----------------------------------------------------------------------------

using System.Collections.Generic;

namespace EveDashboard.Api
{
    /// <summary>
    /// This represents the different refence types used in the journal entries
    /// </summary>
    public class RefTypes : ApiResponse
    {
        /// <summary>
        /// API Version Compatibility
        /// </summary>
        public const string API_VERSION = "2";
        /// <summary>
        /// A reference type is made up of an int, which is the referenceId, and then a string
        /// which is the name of the reference.  They are stored in a serializable dictionary
        /// for easy searching and saving.
        /// </summary>
        public SerializableDictionary<int, string> ReferenceTypes = new SerializableDictionary<int, string>();

        /// <summary>
        /// Returns the description for the specified reference type id
        /// </summary>
        /// <param name="referenceTypeId">ID</param>
        /// <returns>Wallet Journal Description according to the referenceTypeId</returns>
        public string GetReferenceTypeNameForId(int referenceTypeId)
        {
            try
            {
                return ReferenceTypes[referenceTypeId];
            }
            catch (KeyNotFoundException)
            {
                return "Unknown Reference Type Id";
            }
        }
    }
}
